home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / XmToggleButton.z / XmToggleButton
Encoding:
Text File  |  2002-10-03  |  46.2 KB  |  661 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn - The ToggleButton widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////TTTToooogggggggglllleeeeBBBB....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           ToggleButton sets nontransitory state data within an
  20.           application.  Usually this widget consists of an indicator
  21.           (square or diamond) with either text or a pixmap on one side
  22.           of it.  However, it can also consist of just text or a
  23.           pixmap without the indicator.
  24.  
  25.           The toggle graphics display a 1111----ooooffff----mmmmaaaannnnyyyy or NNNN----ooooffff----mmmmaaaannnnyyyy
  26.           selection state.  When a toggle indicator is displayed, a
  27.           square indicator shows an NNNN----ooooffff----mmmmaaaannnnyyyy selection state and a
  28.           diamond indicator shows a 1111----ooooffff----mmmmaaaannnnyyyy selection state.
  29.  
  30.           ToggleButton implies a selected or unselected state.  In the
  31.           case of a label and an indicator, an empty indicator (square
  32.           or diamond shaped) indicates that ToggleButton is
  33.           unselected, and a filled indicator shows that it is
  34.           selected.  In the case of a pixmap toggle, different pixmaps
  35.           are used to display the selected/unselected states.
  36.  
  37.           The default behavior associated with a ToggleButton in a
  38.           menu depends on the type of menu system in which it resides.
  39.           By default, BBBBSSSSeeeelllleeeecccctttt controls the behavior of the
  40.           ToggleButton.  In addition, BBBBMMMMeeeennnnuuuu controls the behavior of
  41.           the ToggleButton if it resides in a PopupMenu system.  The
  42.           actual mouse button used is determined by its RowColumn
  43.           parent.
  44.  
  45.           To accommodate the toggle indicator when created, Label's
  46.           resource XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnLLLLeeeefffftttt may be increased.
  47.  
  48.         CCCCllllaaaasssssssseeeessss
  49.           ToggleButton inherits behavior and resources from CCCCoooorrrreeee,
  50.           XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee, and XXXXmmmmLLLLaaaabbbbeeeellll Classes.
  51.  
  52.           The class pointer is xxxxmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  53.  
  54.           The class name is XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn.
  55.  
  56.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  57.           The following table defines a set of widget resources used
  58.           by the programmer to specify data.  The programmer can also
  59.           set the resource values for the inherited classes to set
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           attributes for this widget.  To reference a resource by name
  75.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  76.           prefix and use the remaining letters.  To specify one of the
  77.           defined values for a resource in a .Xdefaults file, remove
  78.           the XXXXmmmm prefix and use the remaining letters (in either
  79.           lowercase or uppercase, but include any underscores between
  80.           words).  The codes in the access column indicate if the
  81.           given resource can be set at creation time (C), set by using
  82.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  83.           not applicable (N/A).
  84.  
  85.                                            XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  86.      NNNNaaaammmmeeee                         CCCCllllaaaassssssss                        TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  87.      ________________________________________________________________________________________________________
  88.      XmNarmCallback               XmCArmCallback               XtCallbackList   NULL                   C
  89.      XmNdisarmCallback            XmCDisarmCallback            XtCallbackList   NULL                   C
  90.      XmNfillOnSelect              XmCFillOnSelect              Boolean          dynamic                CSG
  91.      XmNindicatorOn               XmCIndicatorOn               Boolean          True                   CSG
  92.      XmNindicatorSize             XmCIndicatorSize             Dimension        dynamic                CSG
  93.      XmNindicatorType             XmCIndicatorType             unsigned char    dynamic                CSG
  94.      XmNselectColor               XmCSelectColor               Pixel            dynamic                CSG
  95.      XmNselectInsensitivePixmap   XmCSelectInsensitivePixmap   Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  96.      XmNselectPixmap              XmCSelectPixmap              Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  97.      XmNset                       XmCSet                       Boolean          False                  CSG
  98.      XmNspacing                   XmCSpacing                   Dimension        4                      CSG
  99.      XmNvalueChangedCallback      XmCValueChangedCallback      XtCallbackList   NULL                   C
  100.      XmNvisibleWhenOff            XmCVisibleWhenOff            Boolean          dynamic                CSG
  101.  
  102.  
  103.           XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  104.                     Specifies the list of callbacks called when the
  105.                     ToggleButton is armed.  To arm this widget, press
  106.                     the active mouse button while the pointer is
  107.                     inside the ToggleButton.  For this callback, the
  108.                     reason is XXXXmmmmCCCCRRRR____AAAARRRRMMMM.
  109.  
  110.           XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  111.                     Specifies the list of callbacks called when
  112.                     ToggleButton is disarmed.  To disarm this widget,
  113.                     press and release the active mouse button while
  114.                     the pointer is inside the ToggleButton.  This
  115.                     widget is also disarmed when the user moves out of
  116.                     the widget and releases the mouse button when the
  117.                     pointer is outside the widget.  For this callback,
  118.                     the reason is XXXXmmmmCCCCRRRR____DDDDIIIISSSSAAAARRRRMMMM.
  119.  
  120.           XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt
  121.                     Fills the indicator with the color specified in
  122.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr and switches the top and bottom
  123.                     shadow colors when set to True.  Otherwise, it
  124.                     switches only the top and bottom shadow colors.
  125.                     The default is set to the value of XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     When XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, and XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt
  141.                     is set explicitly to True, the background is
  142.                     filled with the color specified by XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr.
  143.  
  144.           XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn
  145.                     Specifies that a toggle indicator is drawn to one
  146.                     side of the toggle text or pixmap when set to
  147.                     True.  When set to False, no space is allocated
  148.                     for the indicator, and it is not displayed.  If
  149.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is True, the indicator shadows are
  150.                     switched when the button is selected or
  151.                     unselected, but, any shadows around the entire
  152.                     widget are not switched.  However, if
  153.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, any shadows around the
  154.                     entire widget are switched when the toggle is
  155.                     selected or unselected.
  156.  
  157.           XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrSSSSiiiizzzzeeee
  158.                     Sets the size of the indicator.  If no value is
  159.                     specified, the size of the indicator is based on
  160.                     the size of the label string or pixmap.  If the
  161.                     label string or pixmap changes, the size of the
  162.                     indicator is recomputed based on the size of the
  163.                     label string or pixmap.  Once a value has been
  164.                     specified for XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrSSSSiiiizzzzeeee, the indicator has
  165.                     that size, regardless of the size of the label
  166.                     string or pixmap, until a new value is specified.
  167.  
  168.           XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrTTTTyyyyppppeeee
  169.                     Specifies if the indicator is a 1111----ooooffff or NNNN----ooooffff
  170.                     indicator.  For the 1111----ooooffff indicator, the value is
  171.                     XXXXmmmmOOOONNNNEEEE____OOOOFFFF____MMMMAAAANNNNYYYY.  For the NNNN----ooooffff indicator, the value
  172.                     is XXXXmmmmNNNN____OOOOFFFF____MMMMAAAANNNNYYYY.  The NNNN----ooooffff----mmmmaaaannnnyyyy indicator is
  173.                     square.  The 1111----ooooffff----mmmmaaaannnnyyyy indicator is diamond
  174.                     shaped.  This resource specifies only the visuals
  175.                     and does not enforce the behavior.  When the
  176.                     ToggleButton is in a RadioBox, the default is
  177.                     XXXXmmmmOOOONNNNEEEE____OOOOFFFF____MMMMAAAANNNNYYYY; otherwise, the default is
  178.                     XXXXmmmmNNNN____OOOOFFFF____MMMMAAAANNNNYYYY.
  179.  
  180.           XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr
  181.                     Allows the application to specify what color fills
  182.                     the center of the square or diamond-shaped
  183.                     indicator when it is set.  If this color is the
  184.                     same as either the top or the bottom shadow color
  185.                     of the indicator, a one-pixel-wide margin is left
  186.                     between the shadows and the fill; otherwise, it is
  187.                     filled completely.  This resource's default for a
  188.                     color display is a color between the background
  189.                     and the bottom shadow color.  For a monochrome
  190.                     display, the default is set to the foreground
  191.                     color.  To set the background of the button to
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr when XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, the
  207.                     value of XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt must be explicitly set to
  208.                     True.
  209.  
  210.           XXXXmmmmNNNNsssseeeelllleeeeccccttttIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp
  211.                     Specifies a pixmap used as the button face when
  212.                     the ToggleButton is selected and the button is
  213.                     insensitive if the Label resource XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is
  214.                     set to XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP.  If the ToggleButton is
  215.                     unselected and the button is insensitive, the
  216.                     pixmap in XXXXmmmmNNNNllllaaaabbbbeeeellllIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp is used as the
  217.                     button face.  If no value is specified for
  218.                     XXXXmmmmNNNNllllaaaabbbbeeeellllIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp, that resource is set to
  219.                     the value specified for
  220.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp.
  221.  
  222.           XXXXmmmmNNNNsssseeeelllleeeeccccttttPPPPiiiixxxxmmmmaaaapppp
  223.                     Specifies the pixmap to be used as the button face
  224.                     if XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP and the ToggleButton
  225.                     is selected.  When the ToggleButton is unselected,
  226.                     the pixmap specified in Label's XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  227.                     used.  If no value is specified for
  228.                     XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp, that resource is set to the value
  229.                     specified for XXXXmmmmNNNNsssseeeelllleeeeccccttttPPPPiiiixxxxmmmmaaaapppp.
  230.  
  231.           XXXXmmmmNNNNsssseeeetttt    Represents the state of the ToggleButton.  A value
  232.                     of false indicates that the ToggleButton is not
  233.                     set.   A value of true indicates that the
  234.                     ToggleButton is set.  Setting this resource sets
  235.                     the state of the ToggleButton.
  236.  
  237.           XXXXmmmmNNNNssssppppaaaacccciiiinnnngggg
  238.                     Specifies the amount of spacing between the toggle
  239.                     indicator and the toggle label (text or pixmap).
  240.  
  241.           XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  242.                     Specifies the list of callbacks called when the
  243.                     ToggleButton value is changed.  To change the
  244.                     value, press and release the active mouse button
  245.                     while the pointer is inside the ToggleButton.
  246.                     This action also causes this widget to be
  247.                     disarmed.  For this callback, the reason is
  248.                     XXXXmmmmCCCCRRRR____VVVVAAAALLLLUUUUEEEE____CCCCHHHHAAAANNNNGGGGEEEEDDDD.
  249.  
  250.           XXXXmmmmNNNNvvvviiiissssiiiibbbblllleeeeWWWWhhhheeeennnnOOOOffffffff
  251.                     Indicates that the toggle indicator is visible in
  252.                     the unselected state when the Boolean value is
  253.                     True.  When the ToggleButton is in a menu, the
  254.                     default value is False.  When the ToggleButton is
  255.                     in a RadioBox, the default value is True.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  269.  
  270.  
  271.  
  272.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  273.           ToggleButton inherits behavior and resources from the
  274.           following superclasses.  For a complete description of each
  275.           resource, refer to the man page for that superclass.
  276.  
  277.                                                 XXXXmmmmLLLLaaaabbbbeeeellll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  278.      NNNNaaaammmmeeee                        CCCCllllaaaassssssss                       TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                  AAAAcccccccceeeessssssss
  279.      ___________________________________________________________________________________________________________
  280.      XmNaccelerator              XmCAccelerator              String              NULL                     CSG
  281.      XmNacceleratorText          XmCAcceleratorText          XmString            NULL                     CSG
  282.      XmNalignment                XmCAlignment                unsigned char       dynamic                  CSG
  283.      XmNfontList                 XmCFontList                 XmFontList          dynamic                  CSG
  284.      XmNlabelInsensitivePixmap   XmCLabelInsensitivePixmap   Pixmap              XmUNSPECIFIED_PIXMAP     CSG
  285.      XmNlabelPixmap              XmCLabelPixmap              Pixmap              XmUNSPECIFIED_PIXMAP     CSG
  286.      XmNlabelString              XmCXmString                 XmString            dynamic                  CSG
  287.      XmNlabelType                XmCLabelType                unsigned char       XmSTRING                 CSG
  288.      XmNmarginBottom             XmCMarginBottom             Dimension           dynamic                  CSG
  289.      XmNmarginHeight             XmCMarginHeight             Dimension           2                        CSG
  290.      XmNmarginLeft               XmCMarginLeft               Dimension           dynamic                  CSG
  291.      XmNmarginRight              XmCMarginRight              Dimension           0                        CSG
  292.      XmNmarginTop                XmCMarginTop                Dimension           dynamic                  CSG
  293.      XmNmarginWidth              XmCMarginWidth              Dimension           2                        CSG
  294.      XmNmnemonic                 XmCMnemonic                 KeySym              NULL                     CSG
  295.      XmNmnemonicCharSet          XmCMnemonicCharSet          String              XmFONTLIST_DEFAULT_TAG   CSG
  296.      XmNrecomputeSize            XmCRecomputeSize            Boolean             True                     CSG
  297.      XmNstringDirection          XmCStringDirection          XmStringDirection   dynamic                  CSG
  298.  
  299.                                          XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  300.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  301.      ________________________________________________________________________________________________
  302.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic                CSG
  303.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap             XmUNSPECIFIED_PIXMAP   CSG
  304.      XmNforeground           XmCForeground           Pixel              dynamic                CSG
  305.      XmNhelpCallback         XmCCallback             XtCallbackList     NULL                   C
  306.      XmNhighlightColor       XmCHighlightColor       Pixel              dynamic                CSG
  307.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False                  CSG
  308.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap             dynamic                CSG
  309.      XmNhighlightThickness   XmCHighlightThickness   Dimension          2                      CSG
  310.      XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE                 CSG
  311.      XmNshadowThickness      XmCShadowThickness      Dimension          dynamic                CSG
  312.      XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic                CSG
  313.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap             dynamic                CSG
  314.      XmNtraversalOn          XmCTraversalOn          Boolean            True                   CSG
  315.      XmNunitType             XmCUnitType             unsigned char      dynamic                CSG
  316.      XmNuserData             XmCUserData             XtPointer          NULL                   CSG
  317.  
  318.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  319.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  320.      ______________________________________________________________________________________________________________
  321.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  335.  
  336.  
  337.  
  338.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  339.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  340.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  341.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  342.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  343.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  344.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  345.      XmNdepth                        XmCDepth                        int              dynamic                CG
  346.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  347.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  348.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  349.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  350.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  351.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  352.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  353.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  354.      XmNx                            XmCPosition                     Position         0                      CSG
  355.      XmNy                            XmCPosition                     Position         0                      CSG
  356.  
  357.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  358.           A pointer to the following structure is passed to each
  359.           callback:
  360.  
  361.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  362.           {{{{
  363.             iiiinnnntttt          _r_e_a_s_o_n;;;;
  364.             XXXXEEEEvvvveeeennnntttt       * _e_v_e_n_t;;;;
  365.             iiiinnnntttt          _s_e_t;;;;
  366.           }}}} XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
  367.  
  368.  
  369.           _r_e_a_s_o_n Indicates why the callback was invoked
  370.  
  371.           _e_v_e_n_t  Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback
  372.  
  373.           _s_e_t    Reflects the ToggleButton's current state when the
  374.                  callback occurred, either True (selected) or False
  375.                  (unselected)
  376.  
  377.  
  378.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 4/30/98)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  401.  
  402.  
  403.  
  404.           XmToggleButton includes translations from Primitive.
  405.           Additional XmToggleButton translations for buttons not in a
  406.           menu system are listed below.  These translations may not
  407.           directly correspond to a translation table.
  408.  
  409.           Note that altering translations in ####oooovvvveeeerrrrrrrriiiiddddeeee or ####aaaauuuuggggmmmmeeeennnntttt
  410.           mode is undefined.
  411.  
  412.           BBBBDDDDrrrraaaaggggPPPPrrrreeeessssssss::::    PPPPrrrroooocccceeeessssssssDDDDrrrraaaagggg(((())))
  413.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss:::: AAAArrrrmmmm(((())))
  414.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee::::SSSSeeeelllleeeecccctttt(((())))
  415.                          DDDDiiiissssaaaarrrrmmmm(((())))
  416.           KKKKHHHHeeeellllpppp::::         HHHHeeeellllpppp(((())))
  417.           KKKKSSSSeeeelllleeeecccctttt::::       AAAArrrrmmmmAAAAnnnnddddAAAAccccttttiiiivvvvaaaatttteeee(((())))
  418.  
  419.  
  420.           XmToggleButton inherits menu traversal translations from
  421.           XmLabel.  Additional XmToggleButton translations for
  422.           ToggleButtons in a menu system are listed below.  In a Popup
  423.           menu system, BBBBMMMMeeeennnnuuuu also performs the BBBBSSSSeeeelllleeeecccctttt actions.  These
  424.           translations may not directly correspond to a translation
  425.           table.
  426.  
  427.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss:::: BBBBttttnnnnDDDDoooowwwwnnnn(((())))
  428.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee::::BBBBttttnnnnUUUUpppp(((())))
  429.           KKKKHHHHeeeellllpppp::::         HHHHeeeellllpppp(((())))
  430.           KKKKAAAAccccttttiiiivvvvaaaatttteeee::::     AAAArrrrmmmmAAAAnnnnddddAAAAccccttttiiiivvvvaaaatttteeee(((())))
  431.           KKKKSSSSeeeelllleeeecccctttt::::       AAAArrrrmmmmAAAAnnnnddddAAAAccccttttiiiivvvvaaaatttteeee(((())))
  432.           MMMMAAAAnnnnyyyy KKKKCCCCaaaannnncccceeeellll::::  MMMMeeeennnnuuuuSSSShhhheeeellllllllPPPPooooppppddddoooowwwwnnnnOOOOnnnneeee(((())))
  433.  
  434.  
  435.         AAAAccccttttiiiioooonnnn RRRRoooouuuuttttiiiinnnneeeessss
  436.           The XmToggleButton action routines are described below:
  437.  
  438.  
  439.           AAAArrrrmmmm(((()))):    If the button was previously unset, this action
  440.                     does the following:  If XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is True, it
  441.                     draws the indicator shadow so that the indicator
  442.                     looks pressed; if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt is True, it
  443.                     fills the indicator with the color specified by
  444.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr.  If XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, it
  445.                     draws the button shadow so that the button looks
  446.                     pressed.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the
  447.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttPPPPiiiixxxxmmmmaaaapppp is used as the button face.  Calls
  448.                     the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  449.  
  450.                     If the button was previously set, this action does
  451.                     the following:  If both XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn and
  452.                     XXXXmmmmNNNNvvvviiiissssiiiibbbblllleeeeWWWWhhhheeeennnnOOOOffffffff are True, it draws the indicator
  453.                     shadow so that the indicator looks raised; if
  454.                     XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt is True, it fills the indicator
  455.                     with the background color.  If XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 4/30/98)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  467.  
  468.  
  469.  
  470.                     False, it draws the button shadow so that the
  471.                     button looks raised.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP,
  472.                     the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is used as the button face.
  473.                     Calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  474.  
  475.           AAAArrrrmmmmAAAAnnnnddddAAAAccccttttiiiivvvvaaaatttteeee(((()))):
  476.                     If the ToggleButton was previously set, unsets it;
  477.                     if the ToggleButton was previously unset, sets it.
  478.  
  479.                     In a menu, does the following:  Unposts all menus
  480.                     in the menu hierarchy.  Unless the button is
  481.                     already armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  482.                     Calls the XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk and
  483.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  484.  
  485.                     Outside a menu, if the button was previously
  486.                     unset, this action does the following:  If
  487.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is True, it draws the indicator
  488.                     shadow so that the indicator looks pressed; if
  489.                     XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt is True, it fills the indicator
  490.                     with the color specified by XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr.  If
  491.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, it draws the button
  492.                     shadow so that the button looks pressed.  If
  493.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNsssseeeelllleeeeccccttttPPPPiiiixxxxmmmmaaaapppp is
  494.                     used as the button face.  Calls the
  495.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk, XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk, and
  496.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  497.  
  498.                     Outside a menu, if the button was previously set,
  499.                     this action does the following:  If both
  500.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn and XXXXmmmmNNNNvvvviiiissssiiiibbbblllleeeeWWWWhhhheeeennnnOOOOffffffff are True, it
  501.                     draws the indicator shadow so that the indicator
  502.                     looks raised; if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt is True, it fills
  503.                     the indicator with the background color.  If
  504.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, it draws the button
  505.                     shadow so that the button looks raised.  If
  506.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  507.                     used as the button face.  Calls the
  508.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk, XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk, and
  509.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  510.  
  511.           BBBBttttnnnnDDDDoooowwwwnnnn(((()))):
  512.                     This action unposts any menus posted by the
  513.                     ToggleButton's parent menu, disables keyboard
  514.                     traversal for the menu, and enables mouse
  515.                     traversal for the menu.  It draws the shadow in
  516.                     the armed state and, unless the button is already
  517.                     armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  518.  
  519.           BBBBttttnnnnUUUUpppp(((()))):  This action unposts all menus in the menu
  520.                     hierarchy.  If the ToggleButton was previously
  521.                     set, unsets it; if the ToggleButton was previously
  522.  
  523.  
  524.  
  525.      Page 8                                          (printed 4/30/98)
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  533.  
  534.  
  535.  
  536.                     unset, sets it.  It calls the
  537.                     XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk callbacks and then the
  538.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  539.  
  540.           DDDDiiiissssaaaarrrrmmmm(((()))): Calls the callbacks for XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  541.  
  542.  
  543.           HHHHeeeellllpppp(((()))):   In a Pulldown or Popup MenuPane, unposts all menus
  544.                     in the menu hierarchy and restores keyboard focus
  545.                     to the widget that had the focus before the menu
  546.                     system was entered.  Calls the callbacks for
  547.                     XXXXmmmmNNNNhhhheeeellllppppCCCCaaaallllllllbbbbaaaacccckkkk if any exist.  If there are no
  548.                     help callbacks for this widget, this action calls
  549.                     the help callbacks for the nearest ancestor that
  550.                     has them.
  551.  
  552.           MMMMeeeennnnuuuuSSSShhhheeeellllllllPPPPooooppppddddoooowwwwnnnnOOOOnnnneeee(((()))):
  553.                     In a toplevel Pulldown MenuPane from a MenuBar,
  554.                     unposts the menu, disarms the MenuBar
  555.                     CascadeButton and the MenuBar, and restores
  556.                     keyboard focus to the widget that had the focus
  557.                     before the MenuBar was entered.  In other Pulldown
  558.                     MenuPanes, unposts the menu.
  559.  
  560.                     In a Popup MenuPane, unposts the menu and restores
  561.                     keyboard focus to the widget from which the menu
  562.                     was posted.
  563.  
  564.           PPPPrrrroooocccceeeessssssssDDDDrrrraaaagggg(((()))):
  565.                     Drags the contents of a ToggleButton label,
  566.                     identified by pressing BBBBDDDDrrrraaaagggg.  This action creates
  567.                     a DragContext object whose XXXXmmmmNNNNeeeexxxxppppoooorrrrttttTTTTaaaarrrrggggeeeettttssss
  568.                     resource is set to "COMPOUND_TEXT" for a label
  569.                     type of XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG; otherwise, "PIXMAP" if the label
  570.                     type is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP.  This action is undefined for
  571.                     ToggleButtons used in a menu system.
  572.  
  573.           SSSSeeeelllleeeecccctttt(((()))): If the pointer is within the button, takes the
  574.                     following actions:  If the button was previously
  575.                     unset, sets it; if the button was previously set,
  576.                     unsets it.  Calls the XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  577.                     callbacks.
  578.  
  579.  
  580.         AAAAddddddddiiiittttiiiioooonnnnaaaallll BBBBeeeehhhhaaaavvvviiiioooorrrr
  581.           This widget has the additional behavior described below:
  582.  
  583.  
  584.           <<<<EEEEnnnntttteeeerrrrWWWWiiiinnnnddddoooowwww>>>>:
  585.                     In a menu, if keyboard traversal is enabled, this
  586.                     action does nothing.  Otherwise, it draws the
  587.                     shadow in the armed state and calls the
  588.  
  589.  
  590.  
  591.      Page 9                                          (printed 4/30/98)
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX))))
  599.  
  600.  
  601.  
  602.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  603.  
  604.                     If the ToggleButton is not in a menu and the
  605.                     cursor leaves and then reenters the ToggleButton's
  606.                     window while the button is pressed, this action
  607.                     restores the button's armed appearance.
  608.  
  609.  
  610.           <<<<LLLLeeeeaaaavvvveeeeWWWWiiiinnnnddddoooowwww>>>>:
  611.                     In a menu, if keyboard traversal is enabled, this
  612.                     action does nothing.  Otherwise, it draws the
  613.                     shadow in the unarmed state and calls the
  614.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  615.  
  616.                     If the ToggleButton is not in a menu and the
  617.                     cursor leaves the ToggleButton's window while the
  618.                     button is pressed, this action restores the
  619.                     button's unarmed appearance.
  620.  
  621.  
  622.         VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
  623.           The bindings for virtual keys are vendor specific.  For
  624.           information about bindings for virtual buttons and keys, see
  625.           VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))).
  626.  
  627.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  628.           CCCCoooorrrreeee((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeRRRRaaaaddddiiiiooooBBBBooooxxxx((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnn((((3333XXXX)))),
  629.           XXXXmmmmLLLLaaaabbbbeeeellll((((3333XXXX)))), XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee((((3333XXXX)))), XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))),
  630.           XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGeeeettttSSSSttttaaaatttteeee((((3333XXXX)))), and XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnSSSSeeeettttSSSSttttaaaatttteeee((((3333XXXX)))).
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.      Page 10                                         (printed 4/30/98)
  658.  
  659.  
  660.  
  661.